/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the License at the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apereo.portal.jpa;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.persistence.EntityManager;
import org.springframework.orm.jpa.support.OpenEntityManagerInViewFilter;

/**
 * Opens or uses existing {@link EntityManager}, similar to {@link OpenEntityManagerInViewFilter}
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface OpenEntityManager {

    /**
     * (Optional) The name by which the entity manager is to be accessed in the environment
     * referencing context; not needed when dependency injection is used.
     */
    String name() default "";

    /**
     * (Optional) The name of the persistence unit as defined in the <code>persistence.xml</code>
     * file. If the <code>unitName</code> element is specified, the persistence unit for the entity
     * manager that is accessible in JNDI must have the same name.
     */
    String unitName() default "";
}
